home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / apps / 219 / applic / justify.man < prev    next >
Encoding:
Text File  |  1988-02-09  |  3.9 KB  |  141 lines
  1. .width 79
  2. .hb
  3. .cb
  4. JUSTIFY
  5. version 5.1
  6. 2/9/88
  7.  
  8. a text formatting and reformatting utility
  9.  
  10. by
  11.  
  12. Bruce Holloway
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19. CopyRight (c) 1988 by Bruce Holloway
  20.  
  21. .ce
  22. .he
  23. This document and program may be freely copied and distributed, so long
  24. as it is not copied or distributed for profit, and the header and copyright
  25. messages are preserved.
  26. .pa 0
  27.  
  28. INTRODUCTION
  29.  
  30. JUSTIFY is an intelligent text formatting system - it can take a random bit
  31. of text and often make it look good with very little effort. Output can be
  32. fully tailored both with command line switches and commands in the text.
  33.  
  34. INTELLIGENT FORMATTING
  35.  
  36. Any text that starts more than eight characters away from the left margin
  37. is assumed to be centered. Paragraphs are defined as any text with from one
  38. to eight spaces in front of it, or separated from the previous paragraph by
  39. a blank line. The first line of a new paragraph is indented by a certain
  40. definable amount.
  41.  
  42. COMMAND LINE
  43.  
  44. Commands are of the form
  45. .lb
  46.     justify {switches} [files]
  47.  
  48.     or
  49.  
  50.     justify {switches}
  51. .le
  52. The first method reads in each file, processes it, and writes the output
  53. to [file.jst], where ".jst" replaces whatever extension the file originally
  54. had, or is appended to the end if the file had no extension.
  55.  
  56. The second method works as a filter, reading the standard input, formatting what
  57. it finds, and writing the output to the standard output.
  58.  
  59. ENVIRONMENT
  60.  
  61. "Justify" looks at the environment variable "JUSTIFY" for a default command
  62. line before it processes the actual commands.
  63.  
  64. .sc ~
  65. .dc &
  66. COMMAND LINE SWITCHES
  67.  
  68. &lb
  69.     Switch    Default    Meaning
  70.  
  71.     -b c     -    Set "bar" character.
  72.     -c nnn    75    Set the page width to "nnn" characters.
  73.     -d c     .    Set dot command character.
  74.     -g nnn     5    Set new paragraph indentation.
  75.     -i nnn     5    Set indents to "nnn" spaces.
  76.     -l nnn     0    Lines per page (0 = no page breaks).
  77.     -m c     =    Set "move" character.
  78.     -n nnn     1    Text columns per page.
  79.     -p        Force output to stdout (or output is to <file>.jst)
  80.     -s c     \    Set "separator" character.
  81.     -v        Verbose output (default is quiet output)
  82. &le
  83.  
  84. TEXT COMMANDS
  85.  
  86. These are the document versions of the command line switches. The usual
  87. routine is to fiddle with various switches until the text looks right, then
  88. make the changes permanent by adding them to the text itself.
  89.  
  90. All Text Commands can be abbreviated to the first two characters. They must
  91. begin in the first column of the document, and any text following the
  92. argument (if any) will usually be ignored - so put them on lines by themselves.
  93.  
  94. .. text~Comment. Everything following the dots is ignored.
  95.  
  96. .bar~Draw a line across the text column, ignoring indentation.
  97.  
  98. .move center{\left{\right}}~Draw a TimeSpan move header with the
  99. specified text in the
  100. center, left, and right, separated by the separator character.
  101.  
  102. .bc c~Set the bar character to 'c'.
  103.  
  104. .mc c~Set the char to draw bars around the .move command.
  105.  
  106. .sc c~Sets the separator character used to separate fields in the
  107. .move command.
  108.  
  109. .cb~Start centering.~
  110. .ce~Stop centering. (default)~
  111. .cb text~Center _only_ the text on the same line as the command.
  112.  
  113. .lb~Start literal - no processing is done on the input lines.~
  114. .le~End literal. (default)
  115.  
  116. .jb~Start center justification - text will line up on both left
  117. and right margins. (default)~
  118. .je~Stop justification.
  119.  
  120. .hb~Begin a header. Text in the header uses the entire width of the page
  121. and is centered.~
  122. .he~End a header.
  123.  
  124. .fb~Start filling - as many words as possible per line, even if it
  125. means taking some from the next line. (default)~
  126. .fe~Stop filling.
  127.  
  128. .ib~Indent the left margin by the Indent Width.~
  129. .ie~Outdent the left margin by the Indent Width.
  130.  
  131. .lines n~Set the number of lines per page to "n".
  132.  
  133. .indent n~Set the Indent Width to "n" spaces.
  134.  
  135. .paragraph n~Set the number of spaces to indent the first line of a new
  136. paragraph to "n".
  137.  
  138. .width n~Set the width of a page to "n" columns.
  139.  
  140. .columns n~Start outputting text in "n" columns.
  141.